Shareware Overload Trio 2/Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO/dir36/excr10a.zip/EXCR.DOC

Text File | 1994-07-10 | 26KB | 569 lines

                                     EXCR
                           The EXC Script Recorder
                                 USER'S GUIDE

                       Copyright 1994 by Gary C. Crider


TABLE OF CONTENTS:

        What is EXCR? .................................... 1.0
        Requirements ..................................... 1.1
        The EXCR command line ............................ 2.0
          Parameters that contain quotes ................. 2.1
        How to Use EXCR .................................. 3.0
        The Resulting Script ............................. 4.0
        Playback Timing .................................. 5.0
        Potential Problems ............................... 6.0
        Adjusting EXCR Timing ............................ 7.0
        Installation ..................................... Appendix A
        Definition of Shareware .......................... Appendix B
        Disclaimer ....................................... Appendix C
        Support .......................................... Appendix D
        Registration ..................................... Appendix E


1.0 What is EXCR?

  EXCR is a tool for users of Parity Solutions' EXC program.  EXC is a
generalized script processor for DOS programs.  It will process scripts
that automate tasks in programs that are normally user-interactive.  One
of it's most powerful features is the ability to detect specific information
when it appears on the screen.  If you do not have EXC, this program will
be of no use to you.  You can obtain the latest release ofEXC for trial by
ordering the shareware diskette on the order form at the end of this document.

  EXCR is loaded and executed along with the application program(s) for
which you wish to create a script.  As you type keys and pause for results,
EXC is recording information about the keys you press and the timing of the
key presses.

  When you exit your program, EXC writes out a script file that can then
be executed by EXC to replay what you have just done without you having
to touch a key!

  The script file created by EXCR can be modified with any text editor to
change or enhance its execution.


1.1 Requirements

  EXCR works on any Intel 80x86 and compatible processors.  At this time,
  we are unaware of any unresolved incompatibilities with any software or
  hardware configurations.  Any that are reported and not resolved will
  be reported in this document.

  Since Borland C++ v4.0 no longer supports code generation for 8086/8088
  processors, EXC requires a 286 (80286) or better.

  EXCR requires 512k of free extended memory.

  EXCR requires a 101-key or 102-key (or BIOS-compatible) keyboard.


2.0 The EXCR Command Line

   Format: EXCR [path]scriptfile [[path]program] [command-line parameters]

   The command line is identical to the command line of EXC.  Once you re-
cord a script, you can run EXC using the script by removing the R in EXCR
in the command line.

   The scriptfile is the filename of the script to be created.  The
extension, if specified, must be .SCR, but is not required to be specified.
the script file will be created in the current directory if a path is
not specified.

   The program does not require a file name extension, but it must be a .EXE
or .COM executable program file.  .BAT files cannot be executed by EXCR.  If
the path is not specified, the environment PATH= directories are searched.
If the program is omitted from the command line, COMMAND.COM (or whatever
command processor is reported in the COMSPEC environment variable) is assumed.
Letting the program defaut to COMMAND.COM will probably cause a fatal memory
violation error in an OS/2 DOS box.

   The command-line parameters are any parameters that you would specify
on the DOS command line if you were executing the program without EXCR.


2.1 Parameters that contain quotes

   If you try to pass command-line parameters to the spawned program that
contain imbedded quotes, you must use \q in place of the quotes to be
imbedded within the parameter.

   Parameters that contain spaces, |, < or > must be enclosed in quotes in
order to be treated as a single parameter.

   If you want the spawned program to receive a parameter that looks like:
     Help "Me" Out,
you would include it on the EXC command line as
     "Help \qMe\q Out"

  Confusing?  You bet!  But I have to work within the rules of DOS and the
parameter passing rules of different languages and compilers. Amazingly, they
do not all handle quoted strings in the same manner.  I learned this the
hard way by publishing a release (v2.2) that did not work when spawning most
PASCAL and assembler programs and passing quoted parameters.


3.0 How To use EXCR

  Start EXCR as described under "The EXCR Command Line."  Then you just
perform the task as you normally would.  EXC is recording what you do.
When you quit the task (exit to DOS), EXCR will write the script file
to disk.

  If you started EXC with no program parameter, you will need to type EXIT
on the DOS command line to terminate EXCR and create the script file.

  You could have less problems with the resulting script if you use the
keys on the regular keyboard rather than the numeric keypad.  See the
section on "Potential Problems."


4.0 The Resulting Script

  EXCR uses a very restricted subset of EXC commands within its generated
scripts.  Basically, what scripts recorded with EXCR will do is key some-
thing, then wait, then key something, then wait...  Thus the commands
generated by EXCR are KEY, TYPE, DELAY, TICK and QUIT.

  When EXCR receives a string of character, number or puctuation keys that
are pressed within 1/2 second of the preceeding character, these characters
are strung together as a single string and recorded as a TYPE "string"
command.  This helps prevent the scripts from becoming too lengthy.  The
timing is customizable as described under "Adjusting EXCR timing."

  To calibrate with EXC processing overhead, 4 ticks are deducted from the
interkey timing.  If the result is zero or less, a TICK command is not
written to the script.

  You may want to edit the script file and insert other EXC commands.  You
might want to replay a delay with a WAITFOR, or eliminate many of the TICK
and DELAY commands altogether.  If the program you are executiong does not
clear the keyboard buffer at any point, and you don't overflow the keyboard
buffer, removing TICKs and DELAYs can speed up processing.


5.0 Playback Timing

  Since EXCR accumulates many keystrokes in strings, the playback timing
will usually be somewhat faster than the recording timing.  Delays while
waiting for processing between entering keys or strings should appoximate
the delays as seen during recording.


6.0 Potential problems

  Note that combinations using the ALT and CTL keys and the numeric
keypad often generate key codes that are the same as other key codes or
will generate noe at all.  Some will even generate multiple keyboard
interrupts making it appear as if the key has been pressed twice or even
three times.  The net effect is that the reluts recorded may not be what
you expect, but will usualyy work on playback via EXC, depending on
what the operational program is expecting.

  The Shift key reverses the effect of the Num Lock key on the numeric
keypad just like it does the Caps Lock key on alphbetic keys.

  Overall, you are better off using the keys on the regular keyboard rather
than the numeric keypad when recording a script.  If you have problems
replaying a script that was recorded using the numeric keypad, rerecord it
using the regular keyboard keys.


  The following keys are not recorded:

    Print Screen/System Request **
    Scroll Lock
    Caps Lock *
    Num Lock *
    Pause/Break

   *While not actually recording the pressing of Caps Lock and Num lock, the
    results when letter and/or number keys are subsequently pressed is
    correctly recorded.  For example, if Caps Lock is on, pressing the A key will
    cause captial "A" to be recorded.  Pressing Shift plus the A key will
    cause a lower-case "a" to be recorded, just as it normally does when Caps
    Lock is in effect.

  **While you cannot record the use of the Print Screen key, you can insert
    it into your EXC script with the KEY <PRTSC> command.

  EXCR operates as a keyboard interrupt handler.  There can be more than
one interrupt handler chained together.  According to the rules, each
one does his thing and then passes the key/scan codes on to the next
handler in the chain.  Some handlers are rude, however, and can "steal"
the code from the other handlers and/or bypass them altogether.  Sometimes
this is due to improper programming and sometimes by necessity.  EXCR must
first let the system BIOS handler process the interrupt before it can do
its thing.  This means it must get in the back of the line.  Plus the
operational program that EXCR spawns can install an interrupt handler that
supercedes both EXCR and the system BIOS.  This can account for rare
occasions where some keys don't seem to be recording properly.
Unfortunately, there is nothing that EXCR can do to prevent this behavior.
You can minimize interference from other handlers by removing any pop-up
type TSR (Terminate-and-Stay-Resident) programs before recording.  Odds
are that if they interfere with recording, they will also interfere with
playback.

  EXCR uses 512k of free extended memory.  This could potentially cause a
shortage for the spawned program.


7.0 Adjusting EXCR Timing

  When EXCR receives a string of character, number or puctuation keys that
are pressed within 1/2 second of the preceeding character, these characters
are strung together as a single string and recorded as a TYPE "string"
command.  This helps prevent the scripts from becoming too lengthy.  The
timing is customizable as described below.

  Use the DOS SET command to set an environment variable as shown:

  SET EXCR=5

  The default is 9, if the environment variable does not exist.

  This adjusts the number of ticks that must elapse between characters
before EXCR terminates a string of characters and forces a TYPE command
to be written with characters previously typed.

  Slow typers will probably like a higher number and fast typers will like
a shorter number.  Experiment until words and phrases you type are strung
together in TYPE commands, while keys you press that are not in the logical
string break out into another TYPE command.  Special keys such a ENTER,
function keys, CTRL or ALT combinations, etc. automatically terminate a
string.

  If you want each character typed to create a seperate TYPE command, set
the value to zero.



APPENDIX A

Installation

    EXCR is distributed in a self-extracting ZIP file called EXCR1.EXE or a
ZIP file called EXCR.ZIP.  It contains the following files:

        EXCR.EXE        The executable file for EXCR.
        EXCR.DOC        The documentation file.
        EXCR.HST*       Text description of past updates.
        EXCR.Vnn*       Text description of latest updates in version nn.
        PRODUCTS.DOC    Description of other Parity Solutions products.

        * Version 1.0 will not have these files.

    For best results, extract the file into a directory on your PATH.  If you
don't use a directory in your path, you will have to designate the directory
containing EXCR.EXE when executing the program.  Placing it in the same
directory with EXC.EXE is a good idea.

    If you have a utility directory that is on your PATH, this is an excellent
location for EXCR.  An example installation would be:

    C:
    CD \UNTIL
    COPY [path]EXCR1.EXE  (or COPY [path]EXCR.ZIP)
    EXCR1                 (or PKUNZIP EXCR)
    DEL EXCR1.EXE         (or DEL EXCR.ZIP)

    If they are not currently in your path, simply copy all of the files to a
directory in your path.  Keep the distribution file anywhere you like, but
give plenty of copies, as is, to your friends.  If you register EXCR, you are
not licensed to give your serial number to anybody without first removing the
serialization from your copy.


APPENDIX B


Definition of Shareware
by Paul Mayer, author of GRAB Plus

Shareware distribution gives users a chance to try software before buying
it. If you try a shareware program and continue using it, you are expected
to register. Individual programs differ on details -- some request regis-
tration while others require it, some specify a maximum trial period. With
registration, you get anything from the simple right to continue using the
software to an updated program with printed manual.

Copyright laws apply to both shareware and commercial software, and the
copyright holder retains all rights, with a few specific exceptions as
stated below. Shareware authors are accomplished programmers, just like
commercial authors, and the programs are of comparable quality. (In both
cases, there are good programs and bad ones!) The main difference is in
the method of distribution. The author specifically grants the right to
copy and distribute the software, either to all and sundry or to a
specific group. For example, some authors require written permission
before a commercial disk vendor may copy their shareware.

Shareware is a distribution method, not a type of software. You should find
software that suits your needs and pocketbook, whether it's commercial or
shareware. The Shareware system makes fitting your needs easier, because
you can try before you buy.  And because the overhead is low, prices are
low also. Shareware has the ultimate money-back guarantee -- if you don't
use the product, you don't pay for it.

EXCR.EXE is a shareware program and is provided at no charge to the user for
a 30-day period of evaluation.  Feel free to share it with your friends,
but please do not give it away altered or as part of another system.  The
essence of "user-supported" software is to provide personal computer users
with quality software without high prices, and yet to provide incentive for
programmers to continue to develop new products.



APPENDIX C


Disclaimer

BECAUSE OF THE DIVERSE NATURE OF COMPUTER EQUIPMENT AND EXPERTISE OF USERS,
PARITY SOLUTIONS AND GARY C. CRIDER MAKE NO WARRANTY ON THE EXC PROGRAM
WHATSOEVER, EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THE WARRANTIES
OF MERCHANTABILITY AND OF FITNESS FOR ANY PURPOSE.  THE USER ASSUMES ALL RISK
OF DAMAGE TO DATA OR EQUIPMENT RESULTING DIRECTLY OR INDIRECTLY FROM THE USE
OR MISUSE OF THIS PROGRAM PRODUCT.

USERS ARE ADVISED TO TEST PROGRAMS AND SCRIPTS THOROUGHLY ON DATA FOR WHICH A
BACKUP EXISTS.  ANY LIABILITY OF THE AUTHOR OR PARITY SOLUTIONS IS LIMITED TO
REPLACEMENT OR REFUND OF THE REGISTRATION FEE.




APPENDIX D


Support

    I have tried to test the program to the fullest, but I am limited as to
systems and configurations with which to test.  I have been programming for 20
years and the one thing I know for sure is that bug free programs are very few
and far between.  I can only promise to support the program to the best of my
ability and provide fixes as expeditiously as possible.

    Anyone can report problems and suggest changes.  Registered users get top
priority in resolving their problems.  There are three ways you can report
problems.  The preferred method is to contact me through CIS mail (not forum
messages).  My CIS ID is 71760,3413.  This is the method that is most likely
to be most successful if you are in a hurry as I usually check my mail more
than once per day.

   You can also write me at:

   Gary C. Crider
   Parity Solutions
   1903 Pavia Ct.
   Arlington, TX 76006

    The last method is to phone [phone].  Since I am the sole technical
support and the line is also used for my network consulting business, it is
often hard to get through to me.  Please call and leave a message between 7:30
am and 6:30 pm Central time, or you might actually talk to me after 6:30 pm.
Please don't call after 10:00 pm Central time.

    No matter which method you use, please give a brief description of your
problem, your registration serial number if you are registered, and your phone
number.  If I need more information, I will contact you as soon as I can.
When I have a solution, I will contact you however you prefer.  Never post
your serial number on forum messages.  CIS mail is OK.  I seldom read forum
messages and, in most cases, they are not private.

    At this time there is no charge for support or upgrades and no time
limit for these.  Parity Solutions does reserve the right, however, to
imposes time limitations for free support and upgrades in the future, if it
becomes necessary.  The time limit on free support will never be less than
six months.

    Registered users who are dissatisfied with EXCR may request a refund if
your problem cannot be resolved and is within the scope of the purpose for
which EXCR was designed.  You may request the refund up to 60 days after
registration.  If Parity Solutions chooses not to address problems specific
to a particular hardware or software environment, you are entitled to a
refund of the registration amount.  Refunds do not include any applicable
shipping charges or charges for diskettes, unless the diskette is defective.

    I work full time, have a consulting business to run in my spare time and
write programs instead of sleeping.  So please be a little patient with me.

    Program updates are available on CompuServe or can be requested from us
for a $5 shipping and handling charge.  Add $1 for international shipping
outside the North American continent.  A distribution disk of all Parity
Solutions products will be sent to you.  Specify disk size and format.  You
may use the order form at the end of this document.


APPENDIX H


Registration


    EXCR's full capabilities are available for you to evaluate before you
invest your hard-earned money.  The only difference in operation of a
registered vs. a non-registered program is that the registration prompt will
no longer appear once the program is serialized.  You are also entitled to
support, both while you are evaluating and after you register the program.
See the previous section on support policies.

    You are licensed to use this program freely for thirty (30) days. At the
end of 30 days you are expected to either register the program or quit using
it.  It is a violation of your trial period license to use EXCR longer than
30 days without registering it.

    Registered users will receive a unique serial number and instructions on
how to serialize the program.  Serialization can be re-applied to updated
versions and in no way hinders your use of the program.  You can compress or
decompress the program with no effect (LZEXE or PKLITE).  I use Fabrice
Bellard's LZEXE program on EXCR.EXE before distribution.

    As a registered user, you will be able to upgrade without re-registration
or additional fees.  You will also be kept on my PRIVATE mailing list to
receive additional information on this and other Parity Solutions products.

    To register your copy, please use the order form below and send $16 US
($45 per file server on LANs) check or money order (sorry, no credit cards
yet) to:

   Gary C. Crider
   Parity Solutions
   1903 Pavia Ct.
   Arlington, TX 76006

    Or, you can register individual (non-network) licenses online quickly and
easily in Compuserve.  Simply GO SWREG and register ID #2979.  Your regis-
tration fee will be added to your Compuserve bill.  International exchange
was never easier and you save the $1 international postage charge.

    Texas residents and companies should register by mail and include 7.75
percent sales tax on the total amount of the order.  You can still register
by CompuServe, but I then have to pay the taxes.

    If you send your CIS id or register via CIS:SWREG, your registration will
be sent to you via CIS mail, along with instructions on how to serialize your
copy of EXC.  This usually involves one day or less turnaround.  If you
register online and do not receive a serial number within 3 days, please
contact me via CIS mail.

    Program diskettes are not normally shipped.  Normal distribution of EXCR
and upgrades is via CompuServe.  If you need a diskette, please see the
instructions under Support above, or use the order form below.  You will
receive a serial number and instructions for serializing your copy of the
program.


Single use license:

    Each license gives you or your company a single use permit for EXCR.  It is
    not restricted to a single machine as long as no two users can be simul-
    taneously using the program.  As Borland says, "treat it like a book."  As
    an example, if you register EXCR for your home computer, but during the day
    you use a portable or a computer at work,  you may keep EXCR on both
    machines as long as no one is at home using it while you are using it at
    work, and vice versa.


LAN license:

    LAN licenses grant rights to all workstations on the same physical LAN.
    If internetworking, a license must exist for each file server that contains
    a copy of EXCR.EXE or for each physical local area network that will be
    given rights to access EXCR.EXE.  If two or more file servers exist on a
    single LAN strictly for mirroring data and fault-tolerance, these will be
    counted as a single file server for licensing purposes.  If in doubt,
    contact me.  We can work out an agreement.


Site license:

    Site and enterprise licensing is also available on a negotiated price
    basis.  I guarantee it will be an economical alternative to buying licenses
    for each user.


    You may freely distribute the original shareware distribution file or
distribution diskette intact in any way you see fit other than selling it.
Users' groups and shareware distribution services may charge a reasonable fee
for the medium and duplication costs.  Bulletin boards may not charge
additional fees for downloading this specific program, other than normal
connect-time and/or membership charges.

    As long as it meets the above criteria, any BBS may post EXCR for down-
loading, but should try to keep it up to date.  The latest version is on
CompuServe, or can be obtained from Parity Solutions.  Parity Solutions will
not normally upload upgrades to bulletin boards other than CompuServe.

    You are NOT licensed to give anyone your serial number unless you first
remove all serialization from your computer.  You may then no longer use that
serial number.  Only Parity Solutions has the authority to issue serial
numbers.  If you give or sell your licensed EXCR to anyone else, please have
them send their name, address and serial number to us so that we may update
our customer database.

    Modification of EXCR.EXE in any manner other than lossless compression,
is prohibited and unlawful.

=============================================================================
                           ORDER FORM FOR EXCR

Send checks payable to: Parity Solutions
                        1903 Pavia Court
                        Arlington, TX 76006

BILLING ADDRESS:                        SHIP TO (If different):

NAME:    _____________________________  NAME:      ___________________________

COMPANY: _____________________________  COMPANY: _____________________________

STREET:  _____________________________  STREET:  _____________________________

         _____________________________           _____________________________

CITY/ST: _____________________________  CITY/ST: _____________________________

ZIP/POSTAL CODE: _____________________  ZIP/POSTAL CODE: _____________________

COUNTRY: _____________________________  COUNTRY: _____________________________

PHONE:   _____________________________  PHONE:   _____________________________

CompuServe ID: _______________________(Optional)

   NOTE: Parity Solutions sends a serial number for each registration and
         instructions for serializing your program.  A diskette containing
         the latest releases of all Parity Solutions shareware products is
         available for $5.00 U.S.  The current release of EXC is available
         for downloading on CompuServe in the IBMSYS forum.

   QTY   DESCRIPTION                             PRICE EA.   TOTAL PRICE

   ___   EXCR license and registration             $16.00    ___________

   ___   EXCR Network license and registration      45.00    ___________

   ___   Parity Solutions shareware diskette         5.00    ___________

         Postage for international orders outside    1.00    ___________
         the U.S., Canada and Mexico.
                                         Subtotal:           ___________
 You may deduct 10% from the sub-        Sales tax (Texas
 total if more than one license is       only. - 7.75%)      ___________
 ordered.
                                         Total Enclosed:     ___________

Diskette size (if ordered): __ 5.25" 360k  __ 5.25" 1.2M  __ 3.5" 760k

Thank you for doing business with Parity Solutions.  [phone]

Parity Solutions is a partnership of Gary C. Crider and Russell L. McCloud.
Federal tax identification number 75-2468376.
==============================================================================